home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / DISK / TDIR92.ARJ / TDIR.DOC < prev    next >
Text File  |  1992-03-05  |  6KB  |  175 lines
  1. Subject: Documentation for TreeDir Version 0.92
  2. Date:    March 4, 1992
  3. By:      J. Rockford Cogar, 119 Oklahoma Ave. Oak Ridge, TN 37830
  4.          [Voice] (615) 483-3991
  5.  
  6. Contents.
  7.  
  8. I.    Introduction.
  9. II.   TDIR The Interactive TreeDir Program.
  10.   1.   Introduction.
  11.   2.   Feature List.
  12.   3.   Installation of File Manager Program.
  13.   4.   Command Line Syntax.
  14. III.  TD The non-interactive TreeDir Program.
  15.   1.   Normal Use.
  16.   2.   How to Send a report to a Disk File.
  17.   3.   How to Send a report to a Disk File.
  18. IV.   Technical Notes.
  19. V.    Packing List.
  20.  
  21. I. Introduction.
  22.  
  23.   TreeDir is a set of two programs to  find out how much file storage is in
  24.   every  subdirectory on  a hard  disk.  When  would this  kind of  data be
  25.   useful? Whenever you start running short  of space on your hard disk. The
  26.   TreeDir programs and all source code  are FREEWARE. Use this code any way
  27.   you want.
  28.  
  29.   There are  two versions of  TreeDir. The fancy  one, TDIR.EXE, is  a full
  30.   screen  interactive program  that allows  hard disk  wide management. The
  31.   other TreeDir program is called TD.EXE. TD.EXE generates a simple listing
  32.   of directory by directory storage uses.
  33.  
  34. II.   TDIR The Interactive TreeDir Program.
  35.  
  36.   1. Introduction.
  37.  
  38.    Because the report  generated by TreeDir can be very  long (one line for
  39.    every subdirectory on  the hard disk), an iteractive  version of TreeDir
  40.    has been  included. The interactive  TreeDir program is  named TDIR.EXE.
  41.    From the DOS command line, type:
  42.  
  43.    TDIR <ENTER>
  44.  
  45.    to start the program. After doing a search of the directory structure of
  46.    your  disk, TDIR  will generate  a screen  that resembles  a text editor
  47.    containing something like the following text:
  48.  
  49.   Subdirectory   Storage in KB
  50.   ────────────────────────────
  51.   \ROOT                  6
  52.     \PERI              369
  53.     \MOD               690
  54.     \PAS               916
  55.       \TET              61
  56.     \TC                906
  57.       \SOU             243
  58.       \LIB             129
  59.     \CPP              1603
  60.     \ASM               547
  61.       \TOOLS             2
  62.       \CMP              33
  63.         \ZIP           246
  64.     \TDBUG             731
  65.  
  66.    The  names listed  on the  left are  subdirectories, not filenames. Each
  67.    subdirectory name is  indented 2 spaces for every level  of depth in the
  68.    directory tree. For example the subdirectory '\ZIP' is three levels deep
  69.    in the 'tree'.
  70.  
  71.    The numbers in  the right column are the  sums of all the file  sizes in
  72.    each  respective  subdirectory.  The  subirectory  '\CPP'  contains 1603
  73.    KiloBytes of disk storage (or: 1603 * 1024 = 1641472 bytes).
  74.  
  75.    You can use the normal movement arrows  and page keys to move the bounce
  76.    bar  to different  lines. If  you want  to exit  TDIR into  the selected
  77.    directory press enter. If you want to run a file manager program such as
  78.    PC Magazine's  CO.COM, press F4.  To exit where  you started from  press
  79.    ESC. If  you want to  do a string  search press F9  and enter the sought
  80.    string. Other keys, Home, End, F1 etc, work in the standard fashion.
  81.  
  82.    The source  code for TDIR is  CONIO.ASM and TDIR.PAS. A  Macro Assembler
  83.    (ie: TASM or  MASM) and Borland Turbo Pascal 6.0  is required to rebuild
  84.    TDIR.
  85.  
  86.   2.   Feature List.
  87.  
  88.    The iteractive version of TreeDir includes the following features:
  89.  
  90.     1. Ability to view up to 9999 subdirectory records.
  91.     2. Full cursor control using PgUp, PgDn, Direction keys etc.
  92.     3. String Search
  93.     4. Drop to the specified directory with a bounce bar
  94.     5. Call up a file manager program such as PC Magazines CO.COM to
  95.        operate in a selected directory.
  96.     6. Can also be used to view text files with the "-f" comman
  97.  
  98.   3.   Installation of File Manager Program.
  99.  
  100.    The  default  name  of  the  file   manager  program  used  by  TDIR  is
  101.    "C:\UTIL\CO.COM". The location of that string begins at offset 03038h in
  102.    the file TDIR.EXE. Where offset:
  103.  
  104.     03038h  is the length byte for the file manager program name
  105.     03039h  first byte of the file manager program name
  106.     03079h  last available byte for the file manager program name
  107.  
  108.    You can use a debugger or a hex  editor to alter this section of data to
  109.    match your system.
  110.  
  111.   4. Command Line Syntax.
  112.  
  113.     a. Required.
  114.  
  115.      TDIR <ENTER>
  116.  
  117.     b. Drive Option.
  118.  
  119.      TDIR D: <ENTER>
  120.  
  121.      This allows TDIR to be run on other drives.
  122.  
  123.     c. File Browse Mode Option.
  124.  
  125.      TDIR -fTDIR.DOC <ENTER>
  126.  
  127.      Will run TDIR as a file browser on the file TDIR.DOC.
  128.  
  129. III.  TD The non-interactive TreeDir Program.
  130.  
  131.   1. Normal Use.
  132.  
  133.    To  run the  non-interactive version  of TreeDir  just type  TD <ENTER>.
  134.    TreeDir will  then search through  every subdirectory on  your hard disk
  135.    then generate a report similar to  what is shown in section II.1. Output
  136.    from TD  is sent to  the STDOUT  device  (DOS TTY). This  means that the
  137.    output can be redirected to files, printers or piped to other programs.
  138.  
  139.   2.  How to Send a report to a Disk File.
  140.  
  141.    Just use standard DOS redirection. For example:
  142.  
  143.    TD > sdir.rep <ENTER>
  144.  
  145.    Will send the report to a file named 'SDIR.REP'.
  146.  
  147.   3. How to Send a report to a Disk File.
  148.  
  149.    Enter:
  150.  
  151.    TD > prn <ENTER>
  152.  
  153. IV.  Technical Notes.
  154.  
  155.   While TreeDir is searching through the hard disk all output to the screen is
  156.   done using calls to code in the  Video BIOS. This will work correctly in any
  157.   video  mode. When  TreeDir writes  out the  report it  calls code  in DOS to
  158.   output data to STDOUT.
  159.  
  160.   TreeDir was written  in a mixture of Borland Turbo  Pascal and Borland Turbo
  161.   Assembler.
  162.  
  163. V. Packing List.
  164.  
  165.     Filename  Description
  166.     ──────────────────────────────────────────────────────────
  167.     TD.EXE      The TreeDir Program
  168.     TD.PAS      Source Code for the
  169.     TD.DOC      This Document
  170.     TDIR.PAS    Source Code for the Interactive TreeDir Program.
  171.     TDIR.EXE    The Interactive TreeDir Program
  172.     CONIO.OBJ   Video object code to 'link' into TDIR.exe
  173.     CONIO.ASM   Source Code for the video code
  174.  
  175.